updated readme file
1 changed files with 23 additions and 16 deletions
+ 23
- 16
readme.md
@@ -13,35 +13,42 @@ A template for creating rails websites that includes the following: |
||
| 13 | 13 |
- Maintaince Mode |
| 14 | 14 |
* Email System (PaperClip + Mandrill) |
| 15 | 15 |
|
| 16 |
-Other features are still under development: |
|
| 16 |
+## Installation |
|
| 17 | 17 |
|
| 18 |
-- Log |
|
| 19 |
-- Tests |
|
| 20 |
-- Background processing (redis) |
|
| 21 |
- |
|
| 22 |
-* Search System |
|
| 23 |
-* Wiki/Codex |
|
| 24 |
-- Portfolio |
|
| 25 |
-- Store |
|
| 26 |
-- Inventory |
|
| 27 |
-- Module Controller |
|
| 28 |
-- geo location/maps |
|
| 29 |
-- Help |
|
| 18 |
+1. Clone the project: ```https://github.com/jamesperet/rails_website_template.git``` |
|
| 19 |
+2. Create *postgres* databases for **development** and **test** enviorments. |
|
| 20 |
+3. Configure the databases in ```config/enviorments/development.rb``` and ```config/enviorments/test.rb``` |
|
| 21 |
+4. Run ```rake db:migrate``` |
|
| 22 |
+5. Run ```rake bootstrap:all``` |
|
| 23 |
+6. Start the server: ```rails server -p 3000``` |
|
| 24 |
+7. Login as ```admin@website.com``` with the password ```12345678``` |
|
| 30 | 25 |
|
| 31 | 26 |
## Todo's |
| 32 | 27 |
|
| 28 |
+* Log |
|
| 29 |
+* Tests |
|
| 30 |
+* Background processing (redis) |
|
| 31 |
+* Search System |
|
| 32 |
+* Wiki/Codex |
|
| 33 |
+* Portfolio |
|
| 34 |
+* Store |
|
| 35 |
+* Inventory |
|
| 36 |
+* Module Controller |
|
| 37 |
+* geo location/maps |
|
| 38 |
+* Help |
|
| 33 | 39 |
* new admin email |
| 34 | 40 |
* Invite user/admin |
| 35 | 41 |
* admin panel tour |
| 36 |
- |
|
| 37 | 42 |
* rewrite readme file |
| 38 | 43 |
* Install instructions |
| 39 | 44 |
* Heroku Deploy button |
| 40 | 45 |
|
| 41 | 46 |
## Example Websites |
| 42 | 47 |
|
| 48 |
+- [Velvet Design](http://www.velvetdesign.com.br) (Under Development) |
|
| 43 | 49 |
- [jamesperet.com v2](http://jamesperet.com) (Under Development) |
| 44 | 50 |
- [GoldTone](http://goldtone.com) (Under Development) |
| 45 | 51 |
- [benjaminperet](http://benjaminperet.com) (Under Development) |
| 46 |
-- [High Effects](http://higheffects.com.br) (Upgrade/Rewrite) |
|
| 47 |
-- [Velvet Design](http://www.velvetdesign.com.br) |
|
| 52 |
+- [High Effects](http://higheffects.com.br) (Under Development) |
|
| 53 |
+ |
|
| 54 |
+ |